---
description: What's GraphQL-ESLint, key features and helpful resources.
---

# Introduction

This project integrates GraphQL and ESLint, for a better developer experience.

<figure>
  <video autoPlay loop muted playsInline>
    <source src="/demo.mp4" type="video/mp4" />
  </video>
  <figcaption className="mt-2 text-center text-sm italic">Demo GraphQL-ESLint in VSCode</figcaption>
</figure>

## Features

- Integrates with ESLint core (as a ESTree parser)
- Works on `.graphql` files, `gql` usages and `/* GraphQL */` magic comments
- Lints both GraphQL schema and GraphQL operations
- Extended type info for more advanced usages
- Supports ESLint directives (for example: `eslint-disable-next-line`)
- Easily extendable - supports custom rules based on GraphQL's AST and ESLint API
- Validates, lints, prettifies and checks for best practices across GraphQL schema and GraphQL
  operations
- Integrates with [GraphQL Config](https://the-guild.dev/graphql/config)
- Integrates and visualizes lint issues in popular IDEs (VSCode / WebStorm)

## Resources

- [Shared Schema Policies and Automatic Standards Across Your Company’s Teams](https://youtube.com/watch?v=tjuVrOhdyGY)

- [Introducing GraphQL-ESLint!](https://the-guild.dev/blog/introducing-graphql-eslint)

- [GraphQL-ESLint v3.14 - What's New?](https://the-guild.dev/blog/graphql-eslint-3.14)
